home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1999 July: Mac OS SDK / Dev.CD Jul 99 SDK1.toast / Development Kits / Mac OS / Interfaces&Libraries / Universal / Interfaces / AIncludes / QD3DGroup.a < prev    next >
Encoding:
Text File  |  1998-08-17  |  13.3 KB  |  461 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DGroup.a
  3. ;
  4. ;    Contains:    Q3Group methods        
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    Universal Interfaces 3.2
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        For bug reports, consult the following page on
  12. ;                the World Wide Web:
  13. ;
  14. ;                    http://developer.apple.com/bugreporter/
  15. ;
  16. ;
  17.     IF &TYPE('__QD3DGROUP__') = 'UNDEFINED' THEN
  18. __QD3DGROUP__ SET 1
  19.  
  20.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  21.     include 'QD3D.a'
  22.     ENDIF
  23.  
  24. ; ******************************************************************************
  25. ; **                                                                             **
  26. ; **                            Group Typedefs                                     **
  27. ; **                                                                             **
  28. ; ****************************************************************************
  29.  
  30. ; 
  31. ; * These flags affect how a group is traversed
  32. ; * They apply to when a group is "drawn", "picked", "bounded", "written"
  33. ; 
  34.  
  35.  
  36. ; typedef long                            TQ3DisplayGroupStateMasks
  37. kQ3DisplayGroupStateNone        EQU        0
  38. kQ3DisplayGroupStateMaskIsDrawn    EQU        $01
  39. kQ3DisplayGroupStateMaskIsInline EQU    $02
  40. kQ3DisplayGroupStateMaskUseBoundingBox EQU $04
  41. kQ3DisplayGroupStateMaskUseBoundingSphere EQU $08
  42. kQ3DisplayGroupStateMaskIsPicked EQU    $10
  43. kQ3DisplayGroupStateMaskIsWritten EQU    $20
  44. ; typedef unsigned long                 TQ3DisplayGroupState
  45.  
  46. ; ******************************************************************************
  47. ; **                                                                             **
  48. ; **                    Group Routines (apply to all groups)                     **
  49. ; **                                                                             **
  50. ; ****************************************************************************
  51.  
  52. ;
  53. ; extern TQ3GroupObject Q3Group_New(void )
  54. ;
  55.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  56.         IMPORT_CFM_FUNCTION Q3Group_New
  57.     ENDIF
  58.  
  59. ;
  60. ; extern TQ3ObjectType Q3Group_GetType(TQ3GroupObject group)
  61. ;
  62.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  63.         IMPORT_CFM_FUNCTION Q3Group_GetType
  64.     ENDIF
  65.  
  66. ;
  67. ; extern TQ3GroupPosition Q3Group_AddObject(TQ3GroupObject group, TQ3Object object)
  68. ;
  69.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  70.         IMPORT_CFM_FUNCTION Q3Group_AddObject
  71.     ENDIF
  72.  
  73. ;
  74. ; extern TQ3GroupPosition Q3Group_AddObjectBefore(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  75. ;
  76.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  77.         IMPORT_CFM_FUNCTION Q3Group_AddObjectBefore
  78.     ENDIF
  79.  
  80. ;
  81. ; extern TQ3GroupPosition Q3Group_AddObjectAfter(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  82. ;
  83.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  84.         IMPORT_CFM_FUNCTION Q3Group_AddObjectAfter
  85.     ENDIF
  86.  
  87. ;
  88. ; extern TQ3Status Q3Group_GetPositionObject(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object *object)
  89. ;
  90.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  91.         IMPORT_CFM_FUNCTION Q3Group_GetPositionObject
  92.     ENDIF
  93.  
  94. ;
  95. ; extern TQ3Status Q3Group_SetPositionObject(TQ3GroupObject group, TQ3GroupPosition position, TQ3Object object)
  96. ;
  97.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  98.         IMPORT_CFM_FUNCTION Q3Group_SetPositionObject
  99.     ENDIF
  100.  
  101. ;
  102. ; extern TQ3Object Q3Group_RemovePosition(TQ3GroupObject group, TQ3GroupPosition position)
  103. ;
  104.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  105.         IMPORT_CFM_FUNCTION Q3Group_RemovePosition
  106.     ENDIF
  107.  
  108. ;
  109. ; extern TQ3Status Q3Group_GetFirstPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  110. ;
  111.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  112.         IMPORT_CFM_FUNCTION Q3Group_GetFirstPosition
  113.     ENDIF
  114.  
  115. ;
  116. ; extern TQ3Status Q3Group_GetLastPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  117. ;
  118.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  119.         IMPORT_CFM_FUNCTION Q3Group_GetLastPosition
  120.     ENDIF
  121.  
  122. ;
  123. ; extern TQ3Status Q3Group_GetNextPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  124. ;
  125.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  126.         IMPORT_CFM_FUNCTION Q3Group_GetNextPosition
  127.     ENDIF
  128.  
  129. ;
  130. ; extern TQ3Status Q3Group_GetPreviousPosition(TQ3GroupObject group, TQ3GroupPosition *position)
  131. ;
  132.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  133.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousPosition
  134.     ENDIF
  135.  
  136. ;
  137. ; extern TQ3Status Q3Group_CountObjects(TQ3GroupObject group, unsigned long *nObjects)
  138. ;
  139.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  140.         IMPORT_CFM_FUNCTION Q3Group_CountObjects
  141.     ENDIF
  142.  
  143. ;
  144. ; extern TQ3Status Q3Group_EmptyObjects(TQ3GroupObject group)
  145. ;
  146.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  147.         IMPORT_CFM_FUNCTION Q3Group_EmptyObjects
  148.     ENDIF
  149.  
  150. ; 
  151. ; *     Typed Access
  152. ; 
  153.  
  154. ;
  155. ; extern TQ3Status Q3Group_GetFirstPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  156. ;
  157.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  158.         IMPORT_CFM_FUNCTION Q3Group_GetFirstPositionOfType
  159.     ENDIF
  160.  
  161. ;
  162. ; extern TQ3Status Q3Group_GetLastPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  163. ;
  164.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  165.         IMPORT_CFM_FUNCTION Q3Group_GetLastPositionOfType
  166.     ENDIF
  167.  
  168. ;
  169. ; extern TQ3Status Q3Group_GetNextPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  170. ;
  171.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  172.         IMPORT_CFM_FUNCTION Q3Group_GetNextPositionOfType
  173.     ENDIF
  174.  
  175. ;
  176. ; extern TQ3Status Q3Group_GetPreviousPositionOfType(TQ3GroupObject group, TQ3ObjectType isType, TQ3GroupPosition *position)
  177. ;
  178.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  179.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousPositionOfType
  180.     ENDIF
  181.  
  182. ;
  183. ; extern TQ3Status Q3Group_CountObjectsOfType(TQ3GroupObject group, TQ3ObjectType isType, unsigned long *nObjects)
  184. ;
  185.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  186.         IMPORT_CFM_FUNCTION Q3Group_CountObjectsOfType
  187.     ENDIF
  188.  
  189. ;
  190. ; extern TQ3Status Q3Group_EmptyObjectsOfType(TQ3GroupObject group, TQ3ObjectType isType)
  191. ;
  192.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  193.         IMPORT_CFM_FUNCTION Q3Group_EmptyObjectsOfType
  194.     ENDIF
  195.  
  196. ; 
  197. ; *    Determine position of objects in a group
  198. ; 
  199.  
  200. ;
  201. ; extern TQ3Status Q3Group_GetFirstObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  202. ;
  203.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  204.         IMPORT_CFM_FUNCTION Q3Group_GetFirstObjectPosition
  205.     ENDIF
  206.  
  207. ;
  208. ; extern TQ3Status Q3Group_GetLastObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  209. ;
  210.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  211.         IMPORT_CFM_FUNCTION Q3Group_GetLastObjectPosition
  212.     ENDIF
  213.  
  214. ;
  215. ; extern TQ3Status Q3Group_GetNextObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  216. ;
  217.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  218.         IMPORT_CFM_FUNCTION Q3Group_GetNextObjectPosition
  219.     ENDIF
  220.  
  221. ;
  222. ; extern TQ3Status Q3Group_GetPreviousObjectPosition(TQ3GroupObject group, TQ3Object object, TQ3GroupPosition *position)
  223. ;
  224.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  225.         IMPORT_CFM_FUNCTION Q3Group_GetPreviousObjectPosition
  226.     ENDIF
  227.  
  228.  
  229. ; ******************************************************************************
  230. ; **                                                                             **
  231. ; **                            Group Subclasses                                 **
  232. ; **                                                                             **
  233. ; ****************************************************************************
  234.  
  235. ;
  236. ; extern TQ3GroupObject Q3LightGroup_New(void )
  237. ;
  238.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  239.         IMPORT_CFM_FUNCTION Q3LightGroup_New
  240.     ENDIF
  241.  
  242. ;
  243. ; extern TQ3GroupObject Q3InfoGroup_New(void )
  244. ;
  245.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  246.         IMPORT_CFM_FUNCTION Q3InfoGroup_New
  247.     ENDIF
  248.  
  249. ; ******************************************************************************
  250. ; **                                                                             **
  251. ; **                        Display Group Routines                                 **
  252. ; **                                                                             **
  253. ; ****************************************************************************
  254.  
  255. ;
  256. ; extern TQ3GroupObject Q3DisplayGroup_New(void )
  257. ;
  258.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  259.         IMPORT_CFM_FUNCTION Q3DisplayGroup_New
  260.     ENDIF
  261.  
  262. ;
  263. ; extern TQ3ObjectType Q3DisplayGroup_GetType(TQ3GroupObject group)
  264. ;
  265.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  266.         IMPORT_CFM_FUNCTION Q3DisplayGroup_GetType
  267.     ENDIF
  268.  
  269. ;
  270. ; extern TQ3Status Q3DisplayGroup_GetState(TQ3GroupObject group, TQ3DisplayGroupState *state)
  271. ;
  272.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  273.         IMPORT_CFM_FUNCTION Q3DisplayGroup_GetState
  274.     ENDIF
  275.  
  276. ;
  277. ; extern TQ3Status Q3DisplayGroup_SetState(TQ3GroupObject group, TQ3DisplayGroupState state)
  278. ;
  279.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  280.         IMPORT_CFM_FUNCTION Q3DisplayGroup_SetState
  281.     ENDIF
  282.  
  283. ;
  284. ; extern TQ3Status Q3DisplayGroup_Submit(TQ3GroupObject group, TQ3ViewObject view)
  285. ;
  286.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  287.         IMPORT_CFM_FUNCTION Q3DisplayGroup_Submit
  288.     ENDIF
  289.  
  290. ; ******************************************************************************
  291. ; **                                                                             **
  292. ; **        Ordered Display Group                                                  **
  293. ; **                                                                             **
  294. ; **        Ordered display groups keep objects in order by the type of object:     **
  295. ; **                                                                             **
  296. ; **        1    kQ3ShapeTypeTransform                                             **
  297. ; **        2    kQ3ShapeTypeStyle                                                  **
  298. ; **        3    kQ3SetTypeAttribute                                                  **
  299. ; **        4    kQ3ShapeTypeShader                                                  **
  300. ; **        5    kQ3ShapeTypeCamera                                                  **
  301. ; **        6    kQ3ShapeTypeLight                                                  **
  302. ; **        7    kQ3ShapeTypeGeometry                                             **
  303. ; **        8    kQ3ShapeTypeGroup                                                 **            
  304. ; **        9    kQ3ShapeTypeUnknown                                                 **
  305. ; **                                                                             **
  306. ; **        Within a type, you are responsible for keeping things in order.         **
  307. ; **                                                                             **
  308. ; **        You may access and/or manipulate the group using the above types      **
  309. ; **        (fast), or you may use any parent or leaf class types (slower).         **
  310. ; **                                                                             **
  311. ; **        Additional types will be added as functionality grows.                 **
  312. ; **                                                                             **
  313. ; **        The group calls which access by type are much faster for ordered     ** 
  314. ; **        display group for the types above.                                     **
  315. ; **                                                                             **
  316. ; **        N.B. In QuickDraw 3D 1.0 Lights and Cameras are a no-op when drawn.     **
  317. ; **                                                                             **
  318. ; ****************************************************************************
  319.  
  320. ;
  321. ; extern TQ3GroupObject Q3OrderedDisplayGroup_New(void )
  322. ;
  323.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  324.         IMPORT_CFM_FUNCTION Q3OrderedDisplayGroup_New
  325.     ENDIF
  326.  
  327. ; ******************************************************************************
  328. ; **                                                                             **
  329. ; **        IO Proxy Display Group                                                  **
  330. ; **                                                                             **
  331. ; **        IO Proxy display groups are used to place more than one              **
  332. ; **        representation of an object in a metafile. For example, if you know     **
  333. ; **        another program does not understand NURBPatches but does understand  **
  334. ; **        Meshes, you may place a mesh and a NURB Patch in an IO Proxy Group,  **
  335. ; **        and the reading program will select the desired representation.         **
  336. ; **                                                                             **
  337. ; **        Objects in an IO Proxy Display Group are placed in their preferencial**
  338. ; **        order, with the FIRST object being the MOST preferred, the LAST      **
  339. ; **        object the least preferred.                                             **
  340. ; **                                                                             **
  341. ; **        The behavior of an IO Proxy Display Group is that when drawn/picked/ **
  342. ; **        bounded, the first object in the group that is not "Unknown" is used,**
  343. ; **        and the other objects ignored.                                         **
  344. ; **                                                                             **
  345. ; ****************************************************************************
  346.  
  347. ;
  348. ; extern TQ3GroupObject Q3IOProxyDisplayGroup_New(void )
  349. ;
  350.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  351.         IMPORT_CFM_FUNCTION Q3IOProxyDisplayGroup_New
  352.     ENDIF
  353.  
  354. ; ******************************************************************************
  355. ; **                                                                             **
  356. ; **                        Group Extension Definitions                             **
  357. ; **                                                                             **
  358. ; ****************************************************************************
  359.  
  360. ; 
  361. ; *    Searching methods - OPTIONAL
  362. ; 
  363.  
  364.  
  365. kQ3XMethodType_GroupAcceptObject EQU    'gaco'
  366.  
  367. kQ3XMethodType_GroupAddObject    EQU        'gado'
  368.  
  369. kQ3XMethodType_GroupAddObjectBefore EQU    'gaob'
  370.  
  371. kQ3XMethodType_GroupAddObjectAfter EQU    'gaoa'
  372.  
  373. kQ3XMethodType_GroupSetPositionObject EQU 'gspo'
  374.  
  375. kQ3XMethodType_GroupRemovePosition EQU    'grmp'
  376. ; 
  377. ; *    Searching methods - OPTIONAL - default uses above methods
  378. ; 
  379.  
  380.  
  381. kQ3XMethodType_GroupGetFirstPositionOfType EQU 'gfrt'
  382.  
  383. kQ3XMethodType_GroupGetLastPositionOfType EQU 'glst'
  384.  
  385. kQ3XMethodType_GroupGetNextPositionOfType EQU 'gnxt'
  386.  
  387. kQ3XMethodType_GroupGetPrevPositionOfType EQU 'gpvt'
  388.  
  389. kQ3XMethodType_GroupCountObjectsOfType EQU 'gcnt'
  390.  
  391. kQ3XMethodType_GroupEmptyObjectsOfType EQU 'geot'
  392.  
  393. kQ3XMethodType_GroupGetFirstObjectPosition EQU 'gfop'
  394.  
  395. kQ3XMethodType_GroupGetLastObjectPosition EQU 'glop'
  396.  
  397. kQ3XMethodType_GroupGetNextObjectPosition EQU 'gnop'
  398.  
  399. kQ3XMethodType_GroupGetPrevObjectPosition EQU 'gpop'
  400. ; 
  401. ; *    Group Position Methods
  402. ; *    
  403. ; 
  404.  
  405.  
  406. kQ3XMethodType_GroupPositionSize EQU    'ggpz'
  407. ; typedef unsigned long                 TQ3XMethodTypeGroupPositionSize
  408.  
  409.  
  410. kQ3XMethodType_GroupPositionNew    EQU        'ggpn'
  411.  
  412. kQ3XMethodType_GroupPositionCopy EQU    'ggpc'
  413.  
  414. kQ3XMethodType_GroupPositionDelete EQU    'ggpd'
  415. ; 
  416. ; *    View Drawing Helpers
  417. ; *    
  418. ; *    TQ3XGroupStartIterateMethod
  419. ; *
  420. ; *        Pass back *object = NULL to NOT call EndIterate iterate
  421. ; *        Pass back *object != NULL to draw object
  422. ; *         (other side will pass it to EndIterate for deletion!)
  423. ; *
  424. ; *        *iterator is uninitialized, use for iteration state. Caller should 
  425. ; *         ignore it.
  426. ; *    
  427. ; *    TQ3XGroupEndIterateMethod
  428. ; *    
  429. ; *        *object is previous object, dispose it or play with it.
  430. ; *        Pass back NULL when last iteration has occurred
  431. ; *        *iterator is previous value, use for iteration state Caller should 
  432. ; *        ignore it.
  433. ; 
  434.  
  435.  
  436. kQ3XMethodType_GroupStartIterate EQU    'gstd'
  437.  
  438. kQ3XMethodType_GroupEndIterate    EQU        'gitd'
  439. ; 
  440. ; *    IO  Helpers
  441. ; *    
  442. ; *    TQ3XGroupEndReadMethod
  443. ; *        Called when a group has been completely read. Group should perform
  444. ; *        validation and clean up any reading caches.
  445. ; 
  446.  
  447.  
  448. kQ3XMethodType_GroupEndRead        EQU        'gerd'
  449. ;
  450. ; extern void *Q3XGroup_GetPositionPrivate(TQ3GroupObject group, TQ3GroupPosition position)
  451. ;
  452.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  453.         IMPORT_CFM_FUNCTION Q3XGroup_GetPositionPrivate
  454.     ENDIF
  455.  
  456.  
  457.  
  458.  
  459.     ENDIF ; __QD3DGROUP__ 
  460.  
  461.